home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkHelp.z / VkHelp
Encoding:
Text File  |  1998-10-20  |  4.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkHHHHeeeellllpppp((((3333xxxx))))                                                          VVVVkkkkHHHHeeeellllpppp((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkHelp - Description of ViewKit-supported on-line help facilities
  10.  
  11.  
  12. SSSSeeeeccccuuuurrrriiiittttyyyy NNNNooootttteeee
  13.      _I_t _i_s _k_n_o_w_n _t_h_a_t _s_o_m_e _h_e_l_p _l_i_b_r_a_r_i_e_s _c_a_u_s_e _s_e_c_u_r_i_t_y _p_r_o_b_l_e_m_s, _e_s_p_e_c_i_a_l_l_y
  14.      _f_o_r _p_r_o_g_r_a_m_s _r_u_n_n_i_n_g _s_u_i_d _r_o_o_t.  _Y_o_u _m_u_s_t _r_e_a_d _t_h_e _d_o_c_u_m_e_n_t_a_t_i_o_n _f_o_r
  15.      _w_h_a_t_e_v_e_r _h_e_l_p _l_i_b_r_a_r_y _y_o_u _u_s_e, _l_o_o_k_i_n_g _f_o_r _s_e_c_u_r_i_t_y _c_o_n_c_e_r_n_s.
  16.  
  17.  
  18.  
  19. TTTToooo uuuusssseeee tttthhhheeee ssssttttaaaannnnddddaaaarrrrdddd SSSSGGGGIIII hhhheeeellllpppp lllliiiibbbbrrrraaaarrrryyyy
  20.      _V_k_A_p_p automatically takes care of what is needed for applications that
  21.      want to use the standard SGI help facilities.  For a complete description
  22.      of the standard SGI help facilities, see:
  23.  
  24.    IIIIRRRRIIIIXXXX IIIInnnntttteeeerrrraaaaccccttttiiiivvvveeee DDDDeeeesssskkkkttttoooopppp((((TTTTMMMM)))) IIIInnnntttteeeeggggrrrraaaattttiiiioooonnnn GGGGuuuuiiiiddddeeee
  25.      Describes how to create SGI help.
  26.  
  27.    iiiinnnnssssiiiigggghhhhtttt
  28.      The _i_n_s_i_g_h_t product contains help system developer examples and
  29.      documentation.
  30.  
  31.    iiiinnnnssssiiiigggghhhhtttt____ddddeeeevvvv
  32.      The _i_n_s_i_g_h_t__d_e_v product also contains help system developer examples and
  33.      documentation.  Although you can use the base _i_n_s_i_g_h_t product, creating
  34.      SGI help is much easier with the _i_n_s_i_g_h_t__d_e_v product.
  35.  
  36.  
  37. TTTToooo uuuusssseeee aaaa ccccoooommmmppppaaaattttiiiibbbblllleeee hhhheeeellllpppp lllliiiibbbbrrrraaaarrrryyyy
  38.      if an application wants to provide help its own way, everything is still
  39.      automatic if the application is linked with a library that provides entry
  40.      points that match the SGI help library.
  41.  
  42.      The help entry points are weak symbols in libvk, and must not be weak
  43.      symbols in the application's help library.  Because of the way the loader
  44.      works (9/96), you must be careful that your help routines actually get
  45.      loaded:
  46.  
  47.      +o    If your help library is a DSO, there is not problem.
  48.  
  49.      +o    If your help library is an archive library, you must precede it with
  50.           the _l_d option -_a_l_l.  (If you are giving the option to _C_C, it is
  51.           -_W_l,-_a_l_l.)  You probably also want -_n_o_n_e after loading the help
  52.           library.
  53.  
  54.  
  55. EEEExxxxcccceeeeppppttttiiiioooonnnn
  56.      if the application has something such as a HHHHEEEELLLLPPPP button of its own,
  57.      separate from the _H_e_l_p menu, then the application must:
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkHHHHeeeellllpppp((((3333xxxx))))                                                          VVVVkkkkHHHHeeeellllpppp((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           1) include <Vk/VkHelpAPI.h>
  75.  
  76.           2) call _S_G_I_H_e_l_p_M_s_g() when it needs to.
  77.  
  78. IIIIffff aaaannnn aaaapppppppplllliiiiccccaaaattttiiiioooonnnn ddddooooeeeessss nnnnooootttt wwwwaaaannnntttt ttttoooo pppprrrroooovvvviiiiddddeeee oooonnnn----lllliiiinnnneeee hhhheeeellllpppp
  79.      or if the application is satisfied with the default help capability, then
  80.      there is nothing it needs to do.  ViewKit default help will automatically
  81.      be be available if needed.  See the _I_R_I_S _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e,
  82.      Appendix C, for more information on setting up the default help
  83.      capabilities.
  84.  
  85.  
  86. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  87.      IRIX Interactive Desktop(TM) Integration Guide
  88.      The _i_n_s_i_g_h_t product
  89.      The _i_n_s_i_g_h_t__d_e_v product
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.